<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libxlsxwriter: lxw_image_options Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libxlsxwriter
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">lxw_image_options Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Options for inserted images.  
 <a href="structlxw__image__options.html#details">More...</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Options for modifying images inserted via <code><a class="el" href="worksheet_8h.html#a0b05e75e2c2a5c3452374714cdb2b79b" title="Insert an image in a worksheet cell, with options.">worksheet_insert_image_opt()</a></code>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="image_buffer_8c-example.html#_a4">image_buffer.c</a>, and <a class="el" href="images_8c-example.html#_a9">images.c</a>.</dd>
</dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a7ef9c6980b8e66bcdfff18627250001c"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__image__options.html#a7ef9c6980b8e66bcdfff18627250001c">x_offset</a></td></tr>
<tr class="separator:a7ef9c6980b8e66bcdfff18627250001c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b7d52e42878af3d7c65f7b0ff9f6279"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__image__options.html#a2b7d52e42878af3d7c65f7b0ff9f6279">y_offset</a></td></tr>
<tr class="separator:a2b7d52e42878af3d7c65f7b0ff9f6279"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac75127b545dc66c6a24e3b41bd20a7ab"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__image__options.html#ac75127b545dc66c6a24e3b41bd20a7ab">x_scale</a></td></tr>
<tr class="separator:ac75127b545dc66c6a24e3b41bd20a7ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13a470303d6128f06474111a6807b87b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__image__options.html#a13a470303d6128f06474111a6807b87b">y_scale</a></td></tr>
<tr class="separator:a13a470303d6128f06474111a6807b87b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3affe5a43c455cc61f8e56a0d6d742d4"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__image__options.html#a3affe5a43c455cc61f8e56a0d6d742d4">object_position</a></td></tr>
<tr class="separator:a3affe5a43c455cc61f8e56a0d6d742d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd2ff64da3a930c2b7715ad71fae8d39"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__image__options.html#acd2ff64da3a930c2b7715ad71fae8d39">description</a></td></tr>
<tr class="separator:acd2ff64da3a930c2b7715ad71fae8d39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c023a71168ff25274cfe41ac5403a99"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__image__options.html#a0c023a71168ff25274cfe41ac5403a99">url</a></td></tr>
<tr class="separator:a0c023a71168ff25274cfe41ac5403a99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c11ce77a275cac8ff9aa9ab81edfe01"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlxw__image__options.html#a8c11ce77a275cac8ff9aa9ab81edfe01">tip</a></td></tr>
<tr class="separator:a8c11ce77a275cac8ff9aa9ab81edfe01"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a7ef9c6980b8e66bcdfff18627250001c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ef9c6980b8e66bcdfff18627250001c">&#9670;&nbsp;</a></span>x_offset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t lxw_image_options::x_offset</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Offset from the left of the cell in pixels. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="image_buffer_8c-example.html#a5">image_buffer.c</a>, and <a class="el" href="images_8c-example.html#a10">images.c</a>.</dd>
</dl>

</div>
</div>
<a id="a2b7d52e42878af3d7c65f7b0ff9f6279"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b7d52e42878af3d7c65f7b0ff9f6279">&#9670;&nbsp;</a></span>y_offset</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t lxw_image_options::y_offset</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Offset from the top of the cell in pixels. </p>

</div>
</div>
<a id="ac75127b545dc66c6a24e3b41bd20a7ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac75127b545dc66c6a24e3b41bd20a7ab">&#9670;&nbsp;</a></span>x_scale</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double lxw_image_options::x_scale</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>X scale of the image as a decimal. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="images_8c-example.html#a12">images.c</a>.</dd>
</dl>

</div>
</div>
<a id="a13a470303d6128f06474111a6807b87b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13a470303d6128f06474111a6807b87b">&#9670;&nbsp;</a></span>y_scale</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double lxw_image_options::y_scale</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Y scale of the image as a decimal. </p>

</div>
</div>
<a id="a3affe5a43c455cc61f8e56a0d6d742d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3affe5a43c455cc61f8e56a0d6d742d4">&#9670;&nbsp;</a></span>object_position</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t lxw_image_options::object_position</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Object position - use one of the values of <a class="el" href="worksheet_8h.html#a915c52f231594642bad90422c5b2cf81">lxw_object_position</a>. See <a class="el" href="working_with_object_positioning.html">Working with Object Positioning</a>. </p>

</div>
</div>
<a id="acd2ff64da3a930c2b7715ad71fae8d39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd2ff64da3a930c2b7715ad71fae8d39">&#9670;&nbsp;</a></span>description</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* lxw_image_options::description</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Optional description of the image. Defaults to the image filename as in Excel. Set to "" to ignore the description field. </p>

</div>
</div>
<a id="a0c023a71168ff25274cfe41ac5403a99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c023a71168ff25274cfe41ac5403a99">&#9670;&nbsp;</a></span>url</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* lxw_image_options::url</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Add an optional hyperlink to the image. Follows the same URL rules and types as <code><a class="el" href="worksheet_8h.html#a9b2ac96ee23574a432f5703eedcaf9a1">worksheet_write_url()</a></code>. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="images_8c-example.html#a13">images.c</a>.</dd>
</dl>

</div>
</div>
<a id="a8c11ce77a275cac8ff9aa9ab81edfe01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c11ce77a275cac8ff9aa9ab81edfe01">&#9670;&nbsp;</a></span>tip</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* lxw_image_options::tip</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Add an optional mouseover tip for a hyperlink to the image. </p>

</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.20-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Copyright 2014-2020 John McNamara.
Generated by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
